<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>rsup - Upgrade RiveScript 1.x documents to the new 2.x standards.</title>
<link rel="stylesheet" href="rivescript.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body>


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#options">OPTIONS</a></li>
	<li><a href="#caveats">CAVEATS</a></li>
	<li><a href="#author">AUTHOR</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>rsup - Upgrade RiveScript 1.x documents to the new 2.x standards.</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
  rsup [--out --ext --backup --dontfixperl] &lt;files or folders&gt;</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>When RiveScript was rewritten to a new standard, a certain areas of backwards
compatibility became broken. See the <a href="/RiveScript/WD.html">the RiveScript::WD manpage</a> document for details of
the incompatible changes.</p>
<p>This command-line tool can upgrade obsolete RiveScript code to fix these
incompatibilities and allow it to be parsed by a RiveScript 2 interpreter.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<dl>
<dt><strong><a name="out_directory" class="item">--out &lt;directory&gt;</a></strong>

<dt><strong><a name="o" class="item">-o</a></strong>

<dd>
<p>Specify a directory to output the new documents. If not specified, the files
being read from will be replaced with the new documents.</p>
</dd>
</li>
<dt><strong><a name="ext_extension_rs" class="item">--ext &lt;extension=.rs&gt;</a></strong>

<dt><strong><a name="x" class="item">-x</a></strong>

<dd>
<p>For any arguments that are directories, all files in that directory ending with
this extension are read. Default is <code>.rs</code></p>
</dd>
</li>
<dt><strong><a name="backup" class="item">--backup</a></strong>

<dt><strong><a name="bak" class="item">--bak</a></strong>

<dt><strong><a name="b" class="item">-b</a></strong>

<dd>
<p>Specify this flag if you want backup files (such as those created by Emacs
or gEdit) to be processed. The default is to <strong>not</strong> read these files.</p>
</dd>
</li>
<dt><strong><a name="dontfixperl" class="item">--dontfixperl</a></strong>

<dt><strong><a name="p" class="item">-p</a></strong>

<dd>
<p>When reading in Perl objects, <code>rsup</code> will, by default, attempt to fix the <code>@_</code>
lines to include <code>$rs</code>, the reference to the RS instance. Since this will
modify the code of your object, you can specify this flag to disable this
feature.</p>
</dd>
</li>
<dt><strong><a name="directories_or_documents" class="item">directories or documents</a></strong>

<dd>
<p>After specifying command-line arguments, give <code>rsup</code> a list of directories or
files to work on. For directories, they are opened and any RiveScript documents
inside are automatically processed. For individual files, just these files will
be processed.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="caveats">CAVEATS</a></h1>
<p>This program is still under development. It tries its best to upgrade old
RiveScript code to the new standards, but it's not perfect. It will output
everything it changes to the terminal, but you may need to go through and make
some custom tweaks to fix anything that it didn't translate properly.</p>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Casey Kirsle, <a href="http://www.rivescript.com/">http://www.rivescript.com/</a></p>

</body>

</html>
